home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 2 / Amiga Tools 2.iso / mui / mui-tools / muiiconupdate / mui_iconupdate.doc < prev    next >
Text File  |  1995-03-09  |  8KB  |  208 lines
  1. MUI Icon Update 1.2 by Robert Poole
  2.  
  3. 1. What is it?
  4.  
  5. This program is a replacement for Icon Update 3.0 by Gerri Körner.
  6. I found that his program was very awkward to use, and the CLI version
  7. (Icon Update 2.0) was only slightly easier.  His program also did
  8. funky things with file/path names which made it impossible to access
  9. some icons.  His program also failed to update certain icons because
  10. the write protect bit had been set on that icon and its accompanying
  11. file.
  12.  
  13. The intent of this program is to take the imagery for a given icon
  14. and replace it with the imagery of some other icon.  This has obvious
  15. benefits, if you happen to use MagicWB icons and want to convert
  16. all the icons on your hard drive.  The MagicWB package only has
  17. scripts to fix the icons in your Sys: partition, and to replace
  18. drawer icons in your other partitions.
  19.  
  20. This program does certain "extra" things that might be useful:
  21. It can take a 3-bitplane icon and convert it to an 8-bitplane icon
  22. which displays correctly under AmigaDos 3.x.  My program can also
  23. provide icons for files that don't have icons.  Although my program
  24. has the string gadgets and file requester popups similar to Icon
  25. Update 3.0, MUI Icon Update provides the user with an AppWindow, so
  26. that specifying filenames is a drag-and-drop operation.  My program
  27. also provides a fairly complete ARexx port, so that the user can,
  28. for example, write ARexx scripts to ask MUI Icon Update to change
  29. all the icons in a specific directory, or add icons to a directory
  30. full of files.
  31.  
  32. 2. Usage
  33.  
  34. Couldn't be easier!  All you need to do is specify the "Source"
  35. and "Target" files, make sure you have "checked off" the icon
  36. attributes you wish to preserve in the original icon, and click the
  37. "Start" button.  If everything went OK, you should get a success
  38. requester (unless you have disabled it, see below).  Error conditions
  39. are reported accurately.
  40.  
  41. The "Source" is the file whose icon imagery you wish to use.  The
  42. "Target" is the file whose icon imagery you wish to update/replace;
  43. if the target doesn't have an icon, then it is the file for which
  44. you want to provide an icon.
  45.  
  46. Specifying the source and target files can be done by manually
  47. typing the filename (including path) into the appropriate string
  48. gadget; by clicking the "popfile" button next to the string gadget,
  49. which pops up an ASL file requester; or by dragging the file's icon
  50. onto the appropriate drop box (labelled "Drop Here!").  It is OK
  51. to drop icons which are temporarily generated by Workbench (i.e.,
  52. when you select "Show All" from the Workbench menu).
  53.  
  54. Icon attributes which can be preserved are listed, each with an
  55. accompanying checkbox gadget.  Also, the option "Repair Icon
  56. Structure" has its own checkbox gadget, though it is set apart to
  57. indicate that this is not quite the same function as the other
  58. checkbox gadgets perform.
  59.  
  60. To convert 3-bitplane icons to 8-bitplane icons, use the "Repair
  61. Icon Structure" gadget.  Note that 8-bitplane icons are significantly
  62. larger than their 3-bitplane cousins, but 8-bitplanes are required
  63. for correct display under AmigaDos 3.x, especially if you are using
  64. a Workbench screen with more than 8 colors.
  65.  
  66. If you are sick of the "Update Successful" requester, un-check the
  67. menu option "Display Results?" under the "Settings" menu.
  68.  
  69. 3. Limitations
  70.  
  71. MUI Icon Update is not designed to operate on Disk.info files, although
  72. you can trick it into operating on them in some specific circumstances.
  73. I would recommend strongly that you simply copy Disk.info icons to the
  74. intended partition, rather than use MUI Icon Update.  There is no real
  75. benefit to using MUI Icon Update for this task.
  76.  
  77. I have made every effort to provide this program with innumerable
  78. sanity checks, for your convenience and safety.  This program is
  79. Enforcer tested, and seems to come through with flying colors.  If you
  80. have problems, please don't hesitate to contact me.  (See below.)
  81.  
  82. Dropping multiple icons in a drop box won't cause the program to
  83. operate on each of them.  Rather, only the last of the group will
  84. have its filename inserted in the appropriate string gadget.
  85.  
  86. 4. History
  87.  
  88. 1.0 -- First version, very simplistic operation, had some Enforcer
  89.     hits due to lack of error checking.
  90.  
  91. 1.1 -- Second version, had a slightly improved gadget layout, better
  92.     labelling, more sanity checks, menus, additional ARexx
  93.     commands beyond the standard MUI ARexx commands, and had
  94.     code to detect cases where the target icon was write
  95.     protected and circumvent this (legally).
  96.  
  97. 1.2 -- First public release.  Has improved ARexx command set, is
  98.     smaller, and has more sanity checks.  Works fine on drawers
  99.     and their icons now.  Custom imagery conforms loosely to
  100.     MagicWB style.
  101.  
  102. 5. Future
  103.  
  104. * Have someone design a custom icon for MUI Icon Update.  :-)
  105.  
  106. * Possibly write a custom MUI class so that the imagery inside the
  107.   drop box becomes that of the icon dropped on it.
  108.  
  109. * Possibly add ability to operate on several files at once if the
  110.   user drops more than one icon on a drop box.  (This one is iffy,
  111.   especially since you can do this through ARexx.)
  112.  
  113. * Look into alternative methods of constructing icons that display
  114.   correctly under AmigaDos 3.x.
  115.  
  116. 6. Distribution
  117.  
  118. This program is giftware.  Send me whatever you think is appropriate
  119. as payment, even if it's just email saying, "Hi, I really like your
  120. program!"  :-)
  121.  
  122. Permission is specifically given to Fred Fish to include this archive
  123. in his CD-ROM collection ("Fresh Fish").
  124.  
  125. The package is freely distributable, providing that certain conditions
  126. are met.  You must not modify any of the contents of the archive,
  127. and you must distribute all the original contents of the archive
  128. together.  This includes the MUI_IconUpdate binary executable, the
  129. documentation (this file), MUI.readme, and all associated icons and
  130. support files.
  131.  
  132. I have decided to release source code with this program.  I have done
  133. this so that other programmers will have a reasonably good example
  134. of MUI programming to look at.  However, you may only recompile these
  135. sources for your own personal use.  You may not redistribute modified
  136. versions of the source code, nor may you redistribute binaries
  137. compiled from modified versions of the source code.  If you have
  138. any really nifty modifications you've made, send them along to me so
  139. that I can evaluate them and incorporate them into a future release
  140. of MUI Icon Update.  I am placing this restriction on the source code
  141. so that I don't have to answer support questions about versions that
  142. I didn't write.
  143.  
  144. 7. Legal
  145.  
  146. MagicWB is a product of Martin Huttenloher, and he holds all
  147. appropriate trademarks and copyrights.
  148.  
  149. Icon Update 3.0 is Copyright © 1993 by Gerri Körner
  150.  
  151. AmigaDos® and AppWindow are trademarks of Commodore-Amiga, Inc.
  152.  
  153. MUI Icon Update is Copyright © 1994 by Robert Poole, All Rights
  154. Reserved
  155.  
  156. MUI is Copyright © 1993, 1994 by Stefan Stuntz
  157.  
  158. All other copyrights and trademarks belong to their respective
  159. owners.
  160.  
  161.  
  162. APPENDICES
  163.  
  164. A. ARexx interface
  165.  
  166. In addition to the standard MUI ARexx interface, MUI Icon Update
  167. supports these additional commands:
  168.  
  169. perform
  170.  
  171. Identical to clicking on the "Start" button.
  172.  
  173. query GADNAME/A
  174.  
  175. Query the current state of a checkbox gadget.  The name of the
  176. checkbox gadget is required as an argument, but only the first
  177. character of that name is necessary.  The state of this checkbox
  178. gadget is returned in the ARexx variable RESULT, and is "true"
  179. if the gadget is checked or "false" if it is not.
  180.  
  181. source SOURCEFILE/A
  182.  
  183. Enters the argument SOURCEFILE into the Source string gadget.
  184.  
  185. target TARGETFILE/A
  186.  
  187. Enters the argument TARGETFILE into the Target string gadget.
  188.  
  189. toggle GADNAME/A
  190.  
  191. Toggle the state of a checkbox gadget.  The name of the checkbox
  192. gadget must be supplied as an argument, although only the first
  193. character is needed.  The new state of the checkbox gadget is
  194. returned in the ARexx variable RESULT.
  195.  
  196. B. Contact Information
  197.  
  198. Mail:
  199.  
  200. Robert Poole
  201. 300 South St. Apt. G5
  202. Vernon, CT 06066
  203. U.S.A.
  204.  
  205. Email:
  206. pooler@rpi.edu        (preferred)
  207. pooler@cs.rpi.edu
  208.